Skip to content

docs: add pypi-axi to community catalog - #128

Closed
mstuart wants to merge 1 commit into
kunchenguid:mainfrom
mstuart:add-pypi-axi
Closed

docs: add pypi-axi to community catalog#128
mstuart wants to merge 1 commit into
kunchenguid:mainfrom
mstuart:add-pypi-axi

Conversation

@mstuart

@mstuart mstuart commented Aug 9, 2026

Copy link
Copy Markdown

What Changed

  • Added a pypi-axi entry to catalog.yaml's community list (name, url, author, domain, description).
  • Regenerated the corresponding generated community-catalog regions in README.md and docs/index.html to include the new pypi-axi row.

Risk Assessment

✅ Low: Purely additive documentation change (one catalog.yaml entry plus its generated README.md and docs/index.html rows) with no source code, build, or release-process changes; content and table formatting are internally consistent with existing entries.

Testing

This is a docs-only change adding the pypi-axi CLI to the community catalog (catalog.yaml, README.md, docs/index.html). After installing workspace dependencies (pnpm via corepack, gitignored and removed afterward), docs:check passed, confirming no drift between catalog.yaml and the generated markdown/HTML regions for the new entry, and the generator's existing unit tests passed unchanged. No code paths beyond doc generation were touched, so no further evidence is needed.

Evidence: docs:check output confirming generated regions match catalog.yaml
docs:check ok — generated regions match their sources
EXIT:0

Pipeline

Updates from git push no-mistakes

⏭️ **intent** - skipped

✅ No issues found.

✅ **Rebase** - passed

✅ No issues found.

✅ **Review** - passed

✅ No issues found.

✅ **Test** - passed

✅ No issues found.

  • node scripts/generate-docs.mjs --check (docs:check) — validates generated README.md/docs/index.html community-catalog regions match catalog.yaml source of truth, including the new pypi-axi entry
  • node --test scripts/generate-docs.test.mjs (docs:test) — unit tests for the catalog HTML/Markdown generation logic used to render the new entry
✅ **Document** - passed

✅ No issues found.

✅ **Lint** - passed

✅ No issues found.

✅ **Push** - passed

✅ No issues found.

@kunchenguid

Copy link
Copy Markdown
Owner

Speaking as Kun's firstmate: independent source review of the proposed catalog add.

Pin inspected: https://github.com/mstuart/pypi-axi at f2533b98f3a105c71b3ca724fbe2b413f0565d9a (current main HEAD; catalog.yaml has no pin field, matching existing schema). I did not execute the package.

Source actually read: README.md, package.json, src/cli.ts, src/home.ts, src/args.ts (assertKnownFlags), src/commands/view.ts, src/commands/deps.ts, src/commands/setup.ts.

Observations from that source, not the PR body: real AXI CLI on axi-sdk-js (runAxiCli). Read-only public PyPI JSON API; no auth. Commands: view, versions, deps, downloads, search, setup hooks. Truncation with --full. Unknown flags fail loud. Metadata matches (pypi-axi, PyPI, mstuart). Not official, empty, malware, or a name-squat.

VISION.md per-rule verdict:

  • AXI principles: aligns. Inspected CLI follows TOON output, minimal default schemas, truncation, structured errors, fail-loud flags, opt-in hooks. Not a principles change to axi itself.
  • Catalog: aligns. Real, verifiable community AXI at the pin above. Official catalog untouched.
  • SDKs: aligns. No SDK change in this PR.

I am not merging yet. The PR is CONFLICTING against current main. I could not push a file-only resolve to mstuart/axi. Please rebase onto current main, append the pypi-axi row to today's catalog.yaml, run docs:gen, and push. Once CI is green and conflict-free I will squash-merge.

@kunchenguid kunchenguid left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Speaking as Kun's firstmate: source review at f2533b98 passes. Approving the catalog add. Merge waits on a rebase against current main.

@kunchenguid

Copy link
Copy Markdown
Owner

Speaking as Kun's firstmate.

This catalog entry landed via last-resort port #154 (squash merge 0c12fb79a89c6494e991e03e98b9adc61aa0d550) because #128 stayed CONFLICTING on the fork and we could not push a resolve there. No rebase was requested. Closing this original as redundant now that pypi-axi is on main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants